home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / maximus / lastuser.zip / LASTUSER.DOC < prev    next >
Text File  |  1992-01-08  |  15KB  |  355 lines
  1.                                    LASTUSER
  2.                                    ========
  3.  
  4. Disclaimer....
  5. --------------
  6.  
  7. LASTUSER was written by Rodney Fraser of Fidonet node 1:163/126 and is only
  8. guaranteed to work on his system. Use LASTUSER entirely at your own risk.
  9. Rodney Fraser, John Tod or any of the other beta testers assume no 
  10. responsibility for any damage caused to your computer or your files however
  11. caused by the use or misuse of LASTUSER. The only guarantee is that LASTUSER
  12. will take up space on your disk drive.
  13.  
  14. LASTUSER was designed to work on the Maximus CBCS, version 1.02 Bulletin Board
  15. system only. There is no guarantee that it will work on any other BBS software
  16. or future revisions of Maximus.
  17.  
  18. These docs are written by me, John Tod of node 1:163/114 who graceously 
  19. consented to be a beta tester. Please address any and all comments or
  20. questions to me.
  21.  
  22. LASTUSER may not be sold or included with any software that is sold without
  23. prior consent of the author, Rodney Fraser.
  24.  
  25. What is it....??
  26. ----------------
  27.  
  28. LASTUSER was created for the Maximus CBCS Bulletin Board System and will
  29. allow you to create a file containing a list of the last users who have
  30. called in to your BBS along with such information as how many calls they have
  31. made and what privilege level they have on the BBS. The file created is an
  32. AVATAR style file that will allow Maximus to display it to the next user in
  33. their preferred format. It can be displayed automatically as ASCII, IBM
  34. extended characters or as ANSI/BBS in full colour by Maximus.
  35.  
  36. How it works......
  37. ------------------
  38.  
  39. LASTUSER reads the LASTUSxx.BBS file that is created by Maximus when a user
  40. logs on and either creates or appends a file that will list the last users of
  41. your Bulletin Board. You can display this list to other users so they can see
  42. who has dialed into your BBS in the recent past few hours.
  43.  
  44. Note - The "xx" in LASTUSxx.BBS refers to the task number that is used by
  45. Maximus if you have more than one BBS line. If you are like the majority of
  46. sysops then you will have one phone line and the task number will be "0"
  47. therefore the the lastuser.bbs file created by Maximus will be called
  48. LASTUSER.BBS
  49.  
  50. How to Install LASTUSER.....
  51. ----------------------------
  52.  
  53. Here are the files that should be contained in the archive:
  54.  
  55.          LASTUSER.EXE - the executable program
  56.          SAMPLE.CFG   - a sample config file
  57.          LASTUSER.DOC - this file
  58.          HEADER       - .Zip file header (arc. format maybe changed to .LZH)
  59.  
  60. Copy LASTUSER.EXE into your BBS directory where MAX.EXE resides. You will
  61. then have to modify your BBS batch file to run LASTUSER to create or append
  62. an existing *.BBS file that will be displayed to the next user that logs on
  63. to show them a list of all the past callers up to a limit decided by you.
  64.  
  65. SAMPLE.CFG is only that....a sample file of the real config file to enable
  66. the additional features of LASTUSER which include selectable colours, a
  67. custom banner and changeable privilege level names instead of the Maximus
  68. defaults of "disgrace" or "normal" etc. When you register LASTUSER (details
  69. are at the end) you will be given the name of the file that you rename 
  70. SAMPLE.CFG to so that LASTUSER will be able to use the options defined in it.
  71. Once that is done then you will copy this file into the same directory as 
  72. LASTUSER. Registration is VERY cheap at $1.00 Canadian (or American) or by
  73. simply mailing a postcard. What could be cheaper??? See the details and
  74. mailing address at the end.
  75.  
  76. I use Binkley as a mailer which calls a batch file called SPAWNBBS.BAT that
  77. runs the BBS. When a user logs off the BBS then LASTUSER is allowd to run
  78. which creates or modifies a file of your choosing. Here is how I run LASTUSER
  79. in my SPAWNBBS.BAT file:
  80.  
  81.    echo off
  82.    cls
  83. :loop
  84.    c:
  85.    cd\max
  86.    max -b%1 -p%2 -t%3
  87. .
  88. .
  89. (your other errorlevel exits here)
  90. .
  91. .
  92.   if errorlevel 255 goto end
  93.   if errorlevel 16 goto end
  94.   if errorlevel 12 goto echomail
  95.   if errorlevel 11 goto netmail
  96.   if errorlevel 5 goto lastuser
  97. .
  98. .
  99.  
  100. :echomail
  101.  
  102.   (echomail processing here)
  103.  
  104.   goto lastuser
  105.  
  106. .
  107. .
  108.  
  109. :netmail
  110.  
  111.   (netmail processing here)
  112.  
  113.   goto lastuser
  114.  
  115. .
  116. .
  117.  
  118. :lastuser
  119.  
  120.   c:
  121.   cd\max
  122.   lastuser 15 lastuser.bbs c:\max\misc\maxcall.bbs history.use
  123.   goto end
  124.  
  125. .
  126. .
  127. (other stuff you want to do when a caller logs off)
  128. .
  129. .
  130.  
  131. :end
  132.  
  133.     (pass control to the mailer or other
  134.       front end program to answer the phone)
  135.  
  136.  
  137. Explanation time.....The above is a simplified version of what I do on my BBS.
  138. This does not mean you have to do it this way. LASTUSER should be run after
  139. a caller logs off the BBS and maximus exits with an errorlevel greater than 4.
  140. This means that if a user hung up before completing the log on or an internal
  141. error was detected by Maximus then no LASTUSxx.BBS will be created for that
  142. user and you won't want to run LASTUSER again because it will only add the
  143. last successful callers name onto the end of the caller file again. If Maximus
  144. exits with an errorlevel of 255 or 16 this will indicate an internal problem
  145. such as an internal stack error with Turbo C or some undefined error condition.
  146.  
  147. When Maximus exits with an errorlevel of 11 or 12 this will indicate that
  148. the user has entered echo or net mail or possibly both. You will want to
  149. process this mail first and then run LASTUSER as the last thing before running
  150. your mailer or other front end program to wait for the next caller.
  151.  
  152. When a user logs on a single line BBS, Maximus will create a file called
  153. LASTUSER.BBS in the BBS directory. LASTUSER will then read this file after
  154. the caller has logged off and create or append a file called MAXCALL.BBS (or
  155. other name as defined in the command line) that will list as many callers as
  156. you decide that have called the BBS. The oldest calls will be at the top of
  157. the file with the newest ones at the bottom. It can also create or append a
  158. file called HISTORY.USE which will allow you to have a way of tracing any
  159. problems that may develop with the use of the LASTUSER program. This is
  160. unlikely as I have been using it for a couple of months and have found no
  161. problems with it whatsoever. The HISTORY.USE file parameter is optional
  162. although all the other parameters are essential.
  163.  
  164. The absolute necessary parameters are:
  165.  
  166. - the number of callers that you want listed in the MAXCALL.BBS file
  167. - the FULL PATH and name of the lastuser file created by Maximus which will
  168.   normally be LASTUSER.BBS for a single line BBS.
  169.   Example - C:\MAX\LASTUSER.BBS
  170. - the name of the file that will be created by LASTUSER. This file should
  171.   have a suffix of BBS such as MAXCALL.BBS which will allow you to display
  172.   the file to the next user using the LINK or DISPLAY command as shown later
  173.   in this text. The file name used in the explanation above was MAXCALL.BBS
  174.   Example - C:\MAX\MAXCALL.BBS
  175.  
  176. You may specify an optional parameter at the end that will be the name of the
  177. history file that LASTUSER will create if this option is used.
  178.  
  179. A sample command line might be:
  180.  
  181. LASTUSER 16 LASTUSER.BBS C:\MAX\MISC\MAXCALL.BBS HISTORY.USE
  182.  
  183. This would list up to the last 16 users on the BBS in a file called
  184. MAXCALL.BBS and use the information from the LASTUSER.BBS file and also
  185. create a file called HISTORY.USE that will list all operations of LASTUSER.
  186. It will look for LASTUSER.BBS in the C:\MAX directory and also write
  187. HISTORY.USE in the C:\MAX directory. It will write MAXCALL.BBS in the
  188. C:\MAX\MISC directory.
  189.  
  190. The following will be displayed if no parameters are used with LASTUSER:
  191.  
  192.                 ***************************************
  193.  
  194.    Usage: LASTUSER <##> <lastus??.bbs> <DisplayFile> <HistoryList> @
  195.  
  196.    ##           - number of callers to list. min = 5, no Maximum.
  197.    Lastus??.BBS - full/path to File that  has User's information.
  198.    DisplayFile  - full/path to a  File to  maintain  and  update.
  199.    HistoryFile  - full/path to a File to keep list of every call.
  200.                 - the historyFile is optional. The others aren't.
  201.    @            - use ALIAS name instead of REAL NAME in display.
  202.                 - if no HistoryFile option then this will be 4th.
  203.  
  204.    Note: Run LASTUSER only if Maximus exits with Errorlevel > 2.
  205.  
  206.    Example: LASTUSER 16 lastus01.bbs c:\max\misc\MaxCall.bbs history.Use
  207.  
  208.    Creates/Maintains an Avatar Display file of the  last 16 callers
  209.    called MaxCalls.Bbs in specified directory.  Gets  user info for
  210.    task 01 from Lastus01.BBS in current directory. Will also keep a
  211.    history list called History.Use in current directory.
  212.  
  213.                 ***************************************
  214.  
  215. If the LASTUSxx.BBS file defined in the command line is not found then an
  216. error message such as this will be displayed:
  217.  
  218. => Can't find lastus03.bbs Halting!
  219.  
  220. To get LASTUSER to display the above example I asked LASTUSER to use a 
  221. LASTUSxx.BBS file called LASTUS03.BBS file which is not created by Maximus
  222. on my BBS.
  223.  
  224. How to display the lastuser file to callers....
  225. -----------------------------------------------
  226.  
  227. You can use the LINK or DISPLAY command in a Maximus MECCA file to display
  228. the file created by LASTUSER to callers. I display mine to every caller that
  229. logs in by displaying it as part of my WELCOME.BBS file. Here, in a simplified
  230. way, is how I do it. You can display the file created by LASTUSER wherever you
  231. wish. I only say this is how I do it. Here is a sample WELCOME.BBS file:
  232.  
  233.  
  234. [moreoff ckoff cls]
  235.  
  236.                    Welcome to the NiteFiler BBS
  237.  
  238.  
  239. [enter]
  240.  
  241. [display]c:\max\misc\maxcall
  242.  
  243.  
  244. In the above example I welcome callers to my BBS and then I display the
  245. MAXCALL.BBS file using the [display] command. If you have other stuff to
  246. display to callers in the same file then use the [link] command. There is no
  247. need to use an [enter] or other command after displaying your MAXCALL file as
  248. LASTUSER will automatically put an [enter] code at the end for you.
  249.  
  250. How to register LASTUSER....
  251. ----------------------------
  252.  
  253. Why would you bother to register LASTUSER? Several hours of work has gone
  254. into it and it works fine the way it is. But there is more!! If you register
  255. LASTUSER then you will be told the name of the file that you must rename
  256. SAMPLE.CFG to that will allow you to:
  257.  
  258. - define your own colours
  259. - change the name of the privilege levels instead of the usual "disgrace,
  260.   limited, normal" etc. you can change the names to something like "newuser,
  261.   validated, registered" etc.
  262. - have the name of your BBS displayed at the top of the LASTUSER display file
  263.  
  264. All you have to do to register LASTUSER is to send the author $1.00 or a
  265. postcard or both. Please include your Fidonet address so that he can send
  266. you the name of the configuration file that will allow you to customize
  267. LASTUSER to your own requirements.
  268.  
  269. Send postcards or $1.00 Canadian or American to:
  270.  
  271.     Rodney A. Fraser
  272.     75 Pickford Drive
  273.     Kanata, Ontario
  274.     CANADA
  275.     K2L 2C2
  276.  
  277. P.S.
  278.  
  279. Any donations over $1.00 will be gratefully accepted of course. ;-)
  280.  
  281. These docs are written by me, John Tod of node 1:163/114 who graceously 
  282. consented to be a beta tester. Please address any and all comments or
  283. questions to me.
  284.  
  285. --------------------------------------------------------------------------
  286. Authors Notes:
  287.  
  288. Although the 'display' file appears to be normal file. It is not. It is
  289. a fixed format file. There are a few very important characters contained
  290. within the file that determine file length and starting position of the
  291. list of callers. The first 2 lines of the 'display' file are replaced
  292. everytime the program runs. (the line that creates LOG entry and the
  293. banner line). If you must 'edit' this file then make sure you use an editor
  294. that does not strip the low ASCII avatar colour info. If you want to add
  295. stuff to this file ( somebody will ) then put any optional lines after
  296. the header and before the boxed display part of the file. The 'unregistered'
  297. version adds an extra line to the end of the display. So if you intend to
  298. fill up the display, you'll have to use 1 caller less than the registered
  299. version. Otherwise the user will probably get the 'More [y,n,=]' prompt.
  300. --------------------------------------------------------------------------
  301.  
  302. What's new.
  303.  
  304. February 14, 1991
  305. -----------------
  306.  
  307. 1. Added a new config file option HEADER. Now you can customize the default
  308. coloum headers to suit yourself. Experiment a little till you are satisfied
  309. everything looks correct. Of course the coloumn headers should be displayed
  310. at the top of the coloums. Sample.Cfg has the default 'header' and using
  311. it as an example to position coloum headers is recommended. The header line
  312. is only written when the display file is being created. It is not updated
  313. everytime like the BANNER line and the log entry line.
  314.  
  315. 2. Changed the name of the colour override verb for the banner from C_HED to
  316. C_BAN. Would have been confusing to continue to refer to the banner as the
  317. header. The optional HEADER colour is not adjustable. It will be the same
  318. colour as C_BOX.
  319.  
  320. 3. The display file will be recreated if it ever gets corrupted.
  321.  
  322. October 9, 1991.
  323. ----------------
  324.  
  325. In registered options you can now specify privilege levels and key
  326. combinations.
  327.  
  328. Normal    Regular   % used if no key match found
  329. Normal/5  GoodUser  % used if key 5 is on
  330. Normal/6  SuperUser % used if key 6 is on
  331. Normal/56 Esquire   % used if keys 5 and 6 are both on.
  332. etc..
  333.  
  334. If somebody has only key 8 on and no match (Normal/8) is listed then
  335. the generic replacer for their privilege level is used. If no generic
  336. replacer is declared then the default Maximus privilege is used.
  337.  
  338. January 8, 1992.
  339. ----------------
  340.  
  341. Key support for all 32 keys. (registered option).
  342.  
  343. Changed display format, calls go after time of last call. Justifing
  344. privilege descriptions and added periods to fill out the user name
  345. and location fields. I think it looks better.
  346.  
  347. You can instruct LASTUSER to use `alias' name instead of `realname'
  348. by using the '@' commandline option in all versions or `AliasName'
  349. in you registered .cfg options. Users REAL name will be used in any
  350. optional history file, the ALIAS will only go in the display file.
  351.  
  352. I am moving to Vancouver B.C. at the end of January. I do not know
  353. if I will remain active in FidoNet. Send all questions, comments or
  354. bug reports to John Tod at 1:163/114 or 1:163/316.
  355.